Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TF-PSA-Crypto Doxygen Adaptations #115

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Harry-Ramsey
Copy link
Contributor

@Harry-Ramsey Harry-Ramsey commented Jan 8, 2025

Description

Adapt doxygen scripts to work for TF-PSA-Crypto.

PR checklist

Please add the numbers (or links) of the associated pull requests for consuming branches. You can omit branches where this pull request is not needed.

  • crypto PR Mbed-TLS/TF-PSA-Crypto: #142
  • development PR Mbed-TLS/mbedtls: not required.
  • 3.6 PR Mbed-TLS/mbedtls: not required.

Notes for the submitter

Please refer to the contributing guidelines, especially the
checklist for PR contributors.

Help make review efficient:

  • Multiple simple commits
    • please structure your PR into a series of small commits, each of which does one thing
  • Avoid force-push
    • please do not force-push to update your PR - just add new commit(s)
  • See our Guidelines for Contributors for more details about the review process.

@Harry-Ramsey Harry-Ramsey self-assigned this Jan 8, 2025
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from 3a2fde9 to b22c1b6 Compare January 10, 2025 10:29
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from fe80451 to 41789ad Compare January 10, 2025 12:56
scripts/apidoc_full.sh Outdated Show resolved Hide resolved
scripts/doxygen.sh Outdated Show resolved Hide resolved
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 41789ad to a86eefa Compare January 23, 2025 16:49
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 59e9177 to f16b29c Compare January 30, 2025 16:53
@ronald-cron-arm ronald-cron-arm self-requested a review February 3, 2025 10:58
scripts/all-core.sh Outdated Show resolved Hide resolved
scripts/apidoc_full.sh Show resolved Hide resolved
Comment on lines 35 to 41
elif in_tf_psa_crypto_repo; then
cmake -DCMAKE_BUILD_TYPE:String=Check -DGEN_FILES=ON .
make tfpsacrypto-apidoc
mv $CONFIG_BAK $CONFIG_H
fi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
elif in_tf_psa_crypto_repo; then
cmake -DCMAKE_BUILD_TYPE:String=Check -DGEN_FILES=ON .
make tfpsacrypto-apidoc
mv $CONFIG_BAK $CONFIG_H
fi
elif in_tf_psa_crypto_repo; then
scripts/config.py realfull
cmake -DCMAKE_BUILD_TYPE:String=Check -DGEN_FILES=ON .
make tfpsacrypto-apidoc
mv $CONFIG_BAK $CONFIG_H
fi

and add realfull adapter in config.py in TF-PSA-Crypto the same way it is done in config.py in mbedtls.

scripts/check-doxy-blocks.pl Show resolved Hide resolved
@@ -16,7 +16,8 @@
use File::Basename;

# C/header files in the following directories will be checked
my @directories = qw(include/mbedtls library doxygen/input);
my @mbedtls_directories = qw(include/mbedtls library doxygen/input);
my @tf_psa_crypto_directories = qw(include/psa drivers core doxygen/input);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
my @tf_psa_crypto_directories = qw(include/psa drivers core doxygen/input);
my @tf_psa_crypto_directories = qw(include/psa include/tf-psa-crypto
drivers/builtin/include/mbedtls
drivers/builtin/src core doxygen/input);

@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from f16b29c to 171fd57 Compare February 4, 2025 11:50
This commit adapts check-doxy-blocks to run for TF-PSA-Crypto.

Signed-off-by: Harry Ramsey <[email protected]>
This commit adapts the scripts apidoc_full.sh and doxygen.sh to run for
TF-PSA-Crypto out of source builds.

Signed-off-by: Harry Ramsey <[email protected]>
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 171fd57 to a256c44 Compare February 4, 2025 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants